Run REST Web Service Quick Action

The application provides several options for using web services with Quick Actions.

• Use the Run Web Service Quick Action for SOAP web services.

• Use the Run REST Web Service Quick Action for REST API web services when you need to use simple authentication.

• Use the Web Request Quick Action for REST API web services with Authorization Headers.

About the Run REST Web Service Action

The Run REST Web Service Quick Action allows you to use basic authentication and to store error messages in your chosen field. This Quick Action doesn't allow you to ignore certificate errors from within the action.

The Run REST Web Service Quick Action is available only in the Classic Action Designer.

Using the Run REST Web Service Quick Action

Use the Run REST Web Service Quick Action alone or in a composite Quick Action.

1. From the Classic Action Designer, click the Create New Actions tab,
2. The Run REST Web Service Quick Action can be run as a stand alone action or as a composite action:
   1. Click the Run REST Web Service Quick Action for a stand alone action.
   2. To use the Run REST Web Service Quick Action in a Composite Action:
      • Select Run Rest Web Service from the Add New Action dropdown menu.
      • Click + to add it to the composite action.
3. Complete the parameters:
   • Enter action name: Enter a unique name for the action.
   • Enter action description: (Optional) Describe what the action does.
   • Enter Category: (Optional) Enter the category in which you wish to store the Quick Action.
   • URL: Enter the REST API URL for the target web service.
   • Basic Authentication: Check this box to use basic authentication and require a use ID and password.

   The Web Request Quick Action uses Authorization Headers.

   • Domain Name: Enter the domain name of the API.

   • User ID: Enter a valid user name or ID.

   • Password: Enter a valid password for the user ID.

   • Request Type: Select the web service method for this action: GET, POST, PUT, PATCH, or DELETE.

   • Endpoint: Enter the endpoint of the API request by enclosing the parameter in braces { }.
     For Example:
     example/api/{id}
     In this case id is the endpoint parameter.
   • Result Type: Select the expected data type of the variable when the Store result as field is used in Advanced Settings: Text, Number, Boolean, Raw, JSON, or XML.
   • Store Result In: Specify the field where you want the application to store the result.
   • Store Error Message: Enter the field where you want the application to store web service errors.
   • Header Parameter: Enter the parameters you wish to send in the request header.
   • Standard Parameter: Enter the parameters you want to send in the request body.

     You must provide the entire request body within one standard parameter.

   • Endpoint Parameter: Enter the parameters present in the endpoint field.

     The name of the parameter must match the name in the endpoint field.

4. Complete the Advanced Settings to store responses from the server as variables that you can then use in other Quick Actions.
• Store result as: Create a variable to store the result of the API call.

  The Result Type parameter sets the data type for this variable. If you do not choose a Result Type, the variable stores the result as text.

• Store return code as: Create a text variable to store the HTTP status code.
• Store headers as: Create a text variable to store the response header.
5. Click Save to commit your settings or Cancel to exit without saving.